FSM API

L'API FSM prend en charge les endpoints suivants :

• POST /rest/v2/tickets
• PATCH /rest/v2/tickets/{ticketId}
• PATCH /rest/v2/tickets/
• GET /rest/v2/tickets/{ticketId}
• GET /rest/v2/tickets/
• POST /rest/v1/attachments
• POST /rest/v1/location-nodes
• GET /rest/v1/site-locations
• GESTION DES ERREURS

POST /rest/v2/tickets

Ce endpoint nécessite l'en-tête HTTP ci-dessous

Content-type: application/json
X-Conversation-Id: {Paramètre d'en-tête facultatif fourni par le client}
client_id: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
client_secret: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}

Envoyer une demande d'intervention à l'application LOOMA

Le body à mettre dans l'opération POST a le format suivant ::

{
  "ticketExternalId": "nom du ticket dans le système partenaire",
  "ticketBusinessStatus": "Statut LOOMA du ticket",
  "ticketPriority": "priorité du ticket",
  "ticketType": "type business du ticket (exemple : maintenance corrective)",
  "problemTypeCode": "domaine contractuel fixe de VFF",
  "ticketOriginCode": "Code origine du ticket",
  "ticketClient": "nom du client lié au ticket",
  "companyName": "nom de l'environnement LOOMA",
  "ticketSubject": "sujet du ticket",
  "ticketRemarks": "remarque du ticket",
  "lastActivityRemark": "note du technicien lors de sa dernière intervention",
  "dutyFlag": boolean,
  "outsideBundleFlag": boolean,
  "clientPresenceFlag": boolean,
  "doNotStartBeforeDate": "yyyy-mm-ddThh:mm:ssZ",
  "ticketClientValidator": "email du validateur",
  "workImpactUrgency": "priorité dans mon travail",
  "workEnvironmentImpactUrgency": "priorité dans mon environnement",
  "siteArrivalContractualDate": "yyyy-mm-ddThh:mm:ssZ",
  "siteId": "site d'intervention",
  "contactExternalId": "identifiant du contact",
  "contactEmailAddress": "email du contact",
  "contactFirstName": "prénom du contact",
  "contactLastName": "nom du contact",
  "contactMobilePhone": "numéro de portable du contact",
  "additionalContact": "contact additionnel",
  "ticketEquipmentId": "Id de l'équipement du ticket",
  "serviceLevel1": "catalogue de service categorie 1",
  "serviceLevel2": "catalogue de service categorie 2",
}

PATCH /rest/v2/tickets/{ticketId}

Modifier une demande d'intervention par son identifiant

Le body à mettre dans l'opération PATCH a le format suivant :

{
  "ticketExternalId": "nom du ticket dans le système partenaire",
  "ticketBusinessStatus": "Statut LOOMA du ticket",
  "ticketPriority": "priorité du ticket",
  "ticketType": "type business du ticket (exemple : maintenance corrective)",
  "problemTypeCode": "domaine contractuel fixe de VFF",
  "ticketOriginCode": "Code origine du ticket",
  "ticketClient": "nom du client lié au ticket",
  "companyName": "nom de l'environnement LOOMA",
  "ticketSubject": "sujet du ticket",
  "ticketRemarks": "remarque du ticket",
  "lastActivityRemark": "note du technicien lors de sa dernière intervention",
  "dutyFlag": boolean,
  "outsideBundleFlag": boolean,
  "clientPresenceFlag": boolean,
  "doNotStartBeforeDate": "yyyy-mm-ddThh:mm:ssZ",
  "ticketClientValidator": "email du validateur",
  "workImpactUrgency": "priorité dans mon travail",
  "workEnvironmentImpactUrgency": "priorité dans mon environnement",
  "siteArrivalContractualDate": "yyyy-mm-ddThh:mm:ssZ",
  "siteId": "site d'intervention",
  "contactExternalId": "identifiant du contact",
  "contactEmailAddress": "email du contact",
  "contactFirstName": "prénom du contact",
  "contactLastName": "nom du contact",
  "contactMobilePhone": "numéro de portable du contact",
  "additionalContact": "contact additionnel",
  "ticketEquipmentId": "Id de l'équipement du ticket",
  "serviceLevel1": "catalogue de service categorie 1",
  "serviceLevel2": "catalogue de service categorie 2",
}

PATCH /rest/v2/tickets

Modifier une demande d'intervention par son code interne/ son identifiant externe

Ce endpoint prend en charge les paramètres de requête suivants et leurs combinaisons:

• ticketCode={ticketCode}: paramètre de requête permettant de faire PATCH sur une requête d'intervention par son code
• ticketExternalId={ticketExternalId}: paramètre de requête permettant de faire PATCH sur une requête d'intervention par son identifiant externe

Le body à mettre dans l'opération PATCH a le format suivant :

{
  "ticketExternalId": "nom du ticket dans le système partenaire",
  "ticketBusinessStatus": "Statut LOOMA du ticket",
  "ticketPriority": "priorité du ticket",
  "ticketType": "type business du ticket (exemple : maintenance corrective)",
  "problemTypeCode": "domaine contractuel fixe de VFF",
  "ticketOriginCode": "Code origine du ticket",
  "ticketClient": "nom du client lié au ticket",
  "companyName": "nom de l'environnement LOOMA",
  "ticketSubject": "sujet du ticket",
  "ticketRemarks": "remarque du ticket",
  "lastActivityRemark": "note du technicien lors de sa dernière intervention",
  "dutyFlag": boolean,
  "outsideBundleFlag": boolean,
  "clientPresenceFlag": boolean,
  "doNotStartBeforeDate": "yyyy-mm-ddThh:mm:ssZ",
  "ticketClientValidator": "email du validateur",
  "workImpactUrgency": "priorité dans mon travail",
  "workEnvironmentImpactUrgency": "priorité dans mon environnement",
  "siteArrivalContractualDate": "yyyy-mm-ddThh:mm:ssZ",
  "siteId": "site d'intervention",
  "contactExternalId": "identifiant du contact",
  "contactEmailAddress": "email du contact",
  "contactFirstName": "prénom du contact",
  "contactLastName": "nom du contact",
  "contactMobilePhone": "numéro de portable du contact",
  "additionalContact": "contact additionnel",
  "ticketEquipmentId": "Id de l'équipement du ticket",
  "serviceLevel1": "catalogue de service categorie 1",
  "serviceLevel2": "catalogue de service categorie 2",
}

GET /rest/v2/tickets/{ticketId}

Recupérer une demande d'intervention par son ID

Ce endpoint nécessite l'en-tête HTTP ci-dessous

Content-type: application/json
X-Conversation-Id: {Paramètre d'en-tête facultatif fourni par le client}
client_id: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
client_secret: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
companyName : {paramètre d'en-tête obligatoire fourni par Vinci Facilities}

Le payload renvoyé par l'opération GET a le format suivant :

{
    "header": {

        "apiname" : "{nom de l'API}",
        "apiversion": "{version du schéma suivant le format à un chiffre X}",
        "correlationId": "{correlationId transmis tout au long de la transaction}"
    },
"data": [
{
  "ticketExternalId": "nom du ticket dans le système partenaire",
  "ticketId": "Id interne du ticket LOOMA",
  "ticketCode": "code interne du ticket LOOMA",
  "ticketBusinessStatus": "Statut LOOMA du ticket",
  "ticketPriority": "priorité du ticket",
  "ticketType": "type business du ticket (exemple : maintenance corrective)",
  "problemTypeCode": "domaine contractuel fixe de VFF",
  "ticketOriginCode": "Code origine du ticket",
  "ticketClient": "nom du client lié au ticket",
  "companyName": "nom de l'environnement LOOMA",
  "ticketSubject": "sujet du ticket",
  "ticketRemarks": "remarque du ticket",
  "lastActivityRemark": "note du technicien lors de sa dernière intervention",
  "dutyFlag": boolean,
  "outsideBundleFlag": boolean,
  "clientPresenceFlag": boolean,
  "doNotStartBeforeDate": "yyyy-mm-ddThh:mm:ssZ",
  "ticketClientValidator": "email du validateur",
  "workImpactUrgency": "priorité dans mon travail",
  "workEnvironmentImpactUrgency": "priorité dans mon environnement",
  "siteArrivalContractualDate": "yyyy-mm-ddThh:mm:ssZ",
  "siteId": "site d'intervention",
  "contactExternalId": "identifiant du contact",
  "contactEmailAddress": "email du contact",
  "contactFirstName": "prénom du contact",
  "contactLastName": "nom du contact",
  "contactMobilePhone": "numéro de portable du contact",
  "additionalContact": "contact additionnel",
  "ticketEquipmentId": "Id de l'équipement du ticket",
  "serviceLevel1": "catalogue de service categorie 1",
  "serviceLevel2": "catalogue de service categorie 2",
}
]

GET /rest/v2/tickets/

Récupérer une demande d'intervention par son code interne/ par son identifiant externe

Ce endpoint nécessite l'en-tête HTTP ci-dessous

Content-type: application/json
X-Conversation-Id: {Paramètre d'en-tête facultatif fourni par le client}
client_id: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
client_secret: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
companyName : {paramètre d'en-tête obligatoire fourni par Vinci Facilities}

Ce endpoint prend en charge les paramètres de requête suivants et leurs combinaisons:

• ticketCode={ticketCode}: paramètre de requête permettant d'obtenir une requête d'intervention par son code interne
• ticketExternalId={ticketExternalId}: paramètre de requête permettant d'obtenir une requête d'intervention par son identifiant externe

Le payload renvoyé par l'opération GET a le format suivant :

{
    "header": {

        "apiname" : "{nom de l'API}",
        "apiversion": "{version du schéma suivant le format à un chiffre X}",
        "correlationId": "{correlationId transmis tout au long de la transaction}"
    },
"data": [
{
  "ticketExternalId": "nom du ticket dans le système partenaire",
  "ticketId": "Id interne du ticket LOOMA",
  "ticketCode": "code interne du ticket LOOMA",
  "ticketBusinessStatus": "Statut LOOMA du ticket",
  "ticketPriority": "priorité du ticket",
  "ticketType": "type business du ticket (exemple : maintenance corrective)",
  "problemTypeCode": "domaine contractuel fixe de VFF",
  "ticketOriginCode": "Code origine du ticket",
  "ticketClient": "nom du client lié au ticket",
  "companyName": "nom de l'environnement LOOMA",
  "ticketSubject": "sujet du ticket",
  "ticketRemarks": "remarque du ticket",
  "lastActivityRemark": "note du technicien lors de sa dernière intervention",
  "dutyFlag": boolean,
  "outsideBundleFlag": boolean,
  "clientPresenceFlag": boolean,
  "doNotStartBeforeDate": "yyyy-mm-ddThh:mm:ssZ",
  "ticketClientValidator": "email du validateur",
  "workImpactUrgency": "priorité dans mon travail",
  "workEnvironmentImpactUrgency": "priorité dans mon environnement",
  "siteArrivalContractualDate": "yyyy-mm-ddThh:mm:ssZ",
  "siteId": "site d'intervention",
  "contactExternalId": "identifiant du contact",
  "contactEmailAddress": "email du contact",
  "contactFirstName": "prénom du contact",
  "contactLastName": "nom du contact",
  "contactMobilePhone": "numéro de portable du contact",
  "additionalContact": "contact additionnel",
  "ticketEquipmentId": "Id de l'équipement du ticket",
  "serviceLevel1": "catalogue de service categorie 1",
  "serviceLevel2": "catalogue de service categorie 2",
}
]

POST /rest/v1/attachments

Envoyer une pièce jointe sur une demande de service à l'application LOOMA

Le body à mettre dans l'opération POST a le format suivant :

[{
  "attachmentFileName": "attachmentFileName.pdf",
  "ticketExternalId": "idExterne",
  "attachmentType": "PDF",
  "attachmentExternalId": "attachmentExternalId",
  "attachmentCategory": "LOOMA-XXX",
  "attachmentFileContent": "content"
}]

Les types de fichiers autorisés sont les suivants : pdf, jpeg, txt, png, xlsx, docx, jpg, xls, doc, ppt, pptx, csv, zip

GET /rest/v1/site-locations

Récupérer un site par son id

Ce endpoint nécessite l'en-tête HTTP ci-dessous

Content-type: application/json
X-Conversation-Id: {Paramètre d'en-tête facultatif fourni par le client}
client_id: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
client_secret: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}

Ce endpoint prend en charge le paramètre de requête suivant et leur combinaison:

• siteId={siteId}: paramètre de requête permettant d'obtenir une requête d'un site par son id

Le payload renvoyé par l'opération GET a le format suivant :

{
    "header": {
        "apiname" : "{nom de l'API}",
        "apiversion": "{version du schéma suivant le format à un chiffre X}",
        "correlationId": "{correlationId transmis tout au long de la transaction}"
    },
    "data": [
        {
            "siteId": "identifiant du site",
            "locationId": "id de localisation",
            "locationNodeId": "nodeId",
            "locationParentNodeId": "parentNodeId",
            "locationHierarchyLevel": "niveau hiérarchique",
            "locationDescription": "Description",
            "locationDesignation": "Désignation",
            "locationType": "Type de site",
            "subLevels": [
                {
                    "siteId": "identifiant du site",
                    "locationId": "id de localisation",
                    "locationNodeId": "nodeId",
                    "locationParentNodeId": "parentNodeId",
                    "locationHierarchyLevel": "niveau hiérarchique",
                    "locationDescription": "Description",
                    "locationDesignation": "Désignation",
                    "locationType": "Type de site"
                }
            ]
        }
    ],

POST /rest/v1/location-nodes

Envoyer un élément de localisation présent (batiment, étage, local) sur un site

Ce endpoint nécessite l'en-tête HTTP ci-dessous

Content-type: application/json
X-Conversation-Id: {Paramètre d'en-tête facultatif fourni par le client}
client_id: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}
client_secret: {paramètre d'en-tête obligatoire fourni par la plate-forme Dali}

Le body à mettre dans l'opération POST a le format suivant :

{
  "loomaTypeId": "Type",
  "siteId": "XXXX/00000XX",
  "superiorLocationId": "XXXX/00000XX/00X/000X",
  "typeId": "LOCAL TECHNIQUE",
  "locationName": "API location",
  "userStatusId": "XX",
  "sensitive": "true",
  "scope": "ScopeName"
}

Gestion des erreurs